[Doc] improve thread::Thread and thread::Builder documentations
#41814
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
May 7, 2017 19:31
- Copied the module documentation to `Thread`. - Removed the example because it did not use any method of Thread.
|
(rust_highfive has picked a reviewer for you, use r? to override) |
carols10cents
added
the
S-waiting-on-review
steveklabnik
reviewed
May 9, 2017
src/libstd/thread/mod.rs
Outdated
| @@ -244,6 +244,11 @@ impl Builder { | |||
| /// Generates the base configuration for spawning a thread, from which | |||
| /// configuration methods can be chained. | |||
| /// | |||
| /// If the [`stack_size`][stack_size] field is not specified, the stack size | |||
There was a problem hiding this comment.
changing this to just have
[`stack_size`]
would follow convention
src/libstd/thread/mod.rs
Outdated
| @@ -259,6 +264,8 @@ impl Builder { | |||
| /// | |||
| /// handler.join().unwrap(); | |||
| /// ``` | |||
| /// | |||
| /// [stack_size]: ../../std/thread/struct.Builder.html#method.stack_size | |||
There was a problem hiding this comment.
that means writing
[`stack_size`]: ../../std/
here
src/libstd/thread/mod.rs
Outdated
| @@ -714,33 +721,21 @@ struct Inner { | |||
|
|
|||
| #[derive(Clone)] | |||
| #[stable(feature = "rust1", since = "1.0.0")] | |||
| /// A handle to a thread. | |||
| /// Threads are represented via the `Thread` type, which you can get in one of | |||
| /// two ways: | |||
There was a problem hiding this comment.
This first line needs to be a summary; this doesn't quite work. I think leaving the first line, adding a /// in between, and keeping this new stuff is 👍
|
Done :) |
|
@bors: r+ rollup thanks a ton! |
|
📌 Commit 323a774 has been approved by |
bors
added a commit
that referenced
this pull request
May 9, 2017
[Doc] improve `thread::Thread` and `thread::Builder` documentations Part of #29378 - Adds information about the stack_size when using `Builder`. This might be considered too low level, but I assume that if someone wants to create their own builder instead of using `thread::spawn` they may be interested in that info. - Updates the `thread::Thread` structure doc, mostly by explaining how to get one, the previous example was removed because it was not related to `thread::Thread`, but rather to `thread::Builder::name`. Not much is present there, mostly because this API is not often used (the only method that seems useful is `unpark`, which is documented in #41809).
|
☀️ Test successful - status-appveyor, status-travis |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #29378
Builder. This might be considered too low level, but I assume that if someone wants to create their own builder instead of usingthread::spawnthey may be interested in that info.thread::Threadstructure doc, mostly by explaining how to get one, the previous example was removed because it was not related tothread::Thread, but rather tothread::Builder::name.Not much is present there, mostly because this API is not often used (the only method that seems useful is
unpark, which is documented in [DOC] Improve the thread::park and thread::unpark documentation #41809).